Skip to content

Initial mailer component docs #11626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

Initial mailer component docs #11626

wants to merge 8 commits into from

Conversation

harikt
Copy link
Contributor

@harikt harikt commented May 30, 2019

Hi,

I am trying to make an attempt fix #11531 and move the mailer component doc forward.

I have not heard, the talk by @fabpot . This is not a polished version, but may be something to move on / fix.

Thank you.

Copy link
Member

@weaverryan weaverryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for bootstrapping this @harikt ❤️

Async
-----

If you want to use the async functionality you need to install `messenger` component.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you want to use the async functionality you need to install `messenger` component.
If you want to use the async functionality you need to install the ``messenger`` component.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even better, link to the docs of the component via :doc:.....

@harikt
Copy link
Contributor Author

harikt commented May 30, 2019

@weaverryan I have made the changes as per the request. Some additional changes are added as mentioned on the previous comments.

Copy link
Member

@wouterj wouterj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice work!!

I'm a bit ashamed to have decorated it with so many comments, it's mostly markup comments. If you can't find the time to fix it, no worries: we can also fix them during the merge.

@harikt
Copy link
Contributor Author

harikt commented May 31, 2019

Thank you @wouterj for providing more information. I have in-corporated the changes as per your request.

Copy link
Contributor

@noniagriconomie noniagriconomie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice addition!
good to quick learn by reading doc :)

weaverryan added a commit that referenced this pull request May 31, 2019
This PR was merged into the 4.3 branch.

Discussion
----------

The Mailer Documentation

o/ friends!

Say hello to the Mailer documentation (#11626 does the component).

A lot of the docs were moved from the mime component, and pretty much everything here was tested. Reviews, questions and comments are warmly welcomed.

Note: the first commit was just to "deprecate" the Swift Mailer docs and copy the `email/*` docs into the one, deprecated Swift Mailer document (`email.rst`). Mailer lives in `mailer.rst`.

Cheers!

Commits
-------

c2e92a5 deprecating Swift Mailer and moving all docs into one spot and moving many docs from mime to Mailer and writing it
@harikt
Copy link
Contributor Author

harikt commented Jun 20, 2019

Hi @weaverryan ,

Any reason this PR need to wait ?

@harikt harikt closed this Jun 29, 2019
@bocharsky-bw
Copy link
Contributor

Hey @harikt , I bet this is going to be merged soon, could you reopen this PR and wait a bit more, please?

@weaverryan
Copy link
Member

I agree - reopening - we’re just a little slow at times - sorry!

@weaverryan weaverryan reopened this Jun 30, 2019
Copy link
Member

@weaverryan weaverryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last change requests I think :)

Co-Authored-By: Antoine Makdessi <antoine.makdessi@agriconomie.com>
Co-Authored-By: Ryan Weaver <weaverryan+github@gmail.com>
@harikt
Copy link
Contributor Author

harikt commented Aug 1, 2019

Requested changes has been incorporated.

@weaverryan
Copy link
Member

Thank you @harikt!

@weaverryan weaverryan closed this in 94b9430 Aug 2, 2019
@harikt harikt deleted the mailer branch August 3, 2019 05:58
@harikt
Copy link
Contributor Author

harikt commented Aug 3, 2019

You are welcome @weaverryan . Thank you for taking your valuable time to merge this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the Mailer component
7 participants